From 5039c93d8626f20f0fda17058cb64cd6e35ebe87 Mon Sep 17 00:00:00 2001 From: justbur Date: Fri, 3 Jul 2015 08:39:26 -0400 Subject: [PATCH] Switch readme to org-mode --- README.md | 10 ---------- README.org | 12 ++++++++++++ 2 files changed, 12 insertions(+), 10 deletions(-) delete mode 100644 README.md create mode 100644 README.org diff --git a/README.md b/README.md deleted file mode 100644 index 6f77947c0d8..00000000000 --- a/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# emacs-which-key -Rewrite of guide-key-mode for emacs. - -It's very rough right now. - -Planned features: - 1. Simplify code, especially the trigger mechanism to make it less resource - intensive than guide-key. - 2. Add option to replace descriptions of keys on the fly. - 3. Switch from using popwin to window-purpose. diff --git a/README.org b/README.org new file mode 100644 index 00000000000..3fa356d27d3 --- /dev/null +++ b/README.org @@ -0,0 +1,12 @@ +Rewrite of guide-key-mode for emacs. + +* Status +It is somewhat stable for me at the moment, but expect to see potentially weird +behavior (then to report it to me!). +** Completed +1. Use idle timers to trigger window popup instead of guide-key's constant + polling. +2. Add support for replacement lists to modify key descriptions on the fly. +** Ongoing/Planned +1. Explore alternatives to popwin like window-pupose and using display-buffer + directly -- 2.30.2